.\"
.TH RT-MIGRATE-TEST 8 "September 18, 2020"
# SPDX-License-Identifier: GPL-2.0-only
.\" Please adjust this date whenever editing this manpage
.SH NAME
rt-migrate-test \- real-time task migration program
.SH SYNOPSIS
.LP
rt-migrate-test [-c|--check] [-D|--duration TIME] [-e|--equal] [-h|--help] [--json FILENAME] [-l|--loops LOOPS] [-m|--maxerr TIME] [-p|--prio PRIO] [-r|--run-time TIME] [-s|--sleep-time TIME] [NR_TASKS]
.SH DESCRIPTION
Test real-time multiprocessor scheduling of tasks to ensure the highest priority tasks are running on all available CPUs
.SH OPTIONS
This program follows the usual GNU command line syntax, with long options starting with two dashes ('\-\-').
.br
.TP
In the summary of options, a value in brackets (), indicates a default value
.br
.TP
.B \-c, \-\-check
Stop if lower prio task is quicker than higher (off)
.TP
.B \-D, \-\-duration=TIME
Specify a length for the test run.
.br
Append 'm', 'h', or 'd' to specify minutes, hours or days.
.TP
.B \-e, \-\-equal
Use equal prio for #CPU-1 tasks (requires > 2 CPUS)
.br
.TP
.B \-h, \-\-help
Display usage
.br
.TP
.B \-\-json=FILENAME
Write final results into FILENAME, JSON formatted.
.br
.TP
.B \-l \-\-loops=LOOPS
Number of iterations to run (50)
.br
.TP
.B \-m, \-\-maxerr=TIME
Max allowed error (microsecs)
.br
.TP
.B \-p, \-\-prio=PRIO
base priority to start RT tasks with (2)
.br
.TP
.B \-r, \-\-run\-time=TIME
Run time (ms) to busy loop the threads (20)
.br
.TP
.B \-s, \-\-sleep\-time=TIME
Sleep time (ms) between intervals (100)
.br
.TP
.B [NR_TASKS]
number of tasks to run (number of cpus + 1)
.br
.SH AUTHOR
rt-migrate-test was written by Steven Rostedt <srostedt@redhat.com>
.TP
This manual page was written by John Kacur <jkacur@redhat.com>
